home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / clqwk100.zip / CLEANQWK.DOC < prev    next >
Text File  |  1994-05-19  |  16KB  |  354 lines
  1.  
  2.                 ┌───────────────────────────────────────┐
  3.                 │            CLEANQWK v1.00             │
  4.                 │    Copyright (C) 1994  Joe Malkin     │
  5.                 └───────────────────────────────────────┘
  6.  
  7. _________________________________________________________________________
  8.  
  9.       Please read the legal stuff at the end of this document file.
  10.      CLEANQWK is distributed subject to the conditions listed there.
  11.      If you can't accept the conditions, just don't use the program!
  12. _________________________________________________________________________
  13.  
  14.  
  15.  
  16. 1.      WHAT DOES CLEANQWK DO?
  17. ______________________________
  18.  
  19.  
  20. CLEANQWK is designed to increase your QWK mail reading pleasure by
  21. removing the rubbish you don't want to see from your downloaded packets,
  22. and by highlighting those messages that are of most interest to you by
  23. including them with your "personal" messages.
  24.  
  25. CLEANQWK is run from the DOS prompt after you have downloaded a QWK
  26. packet, and processes the packet before you import it into your offline
  27. mail reader.  All of the options listed below are configurable, and can
  28. be set up to match your individual taste.
  29.  
  30. --- CLEANQWK will strip out the unwanted lines in internet/Usenet
  31.     messages.  You can decide for yourself which lines are to be kept.
  32.  
  33. --- The program creates *.NDX files for you.  You can reduce your time
  34.     online by toggling the option in the mail door so that your QWK
  35.     packet does not include the *.NDX files.
  36.  
  37. --- The program deletes duplicate messages in the package, even across
  38.     newsgroups.
  39.  
  40. --- It can remove messages from and to designated "twits" (particular
  41.     users whose meanderings are of no interest to you).
  42.  
  43. --- It can put messages from and to "dear" users in your personal
  44.     conference.
  45.  
  46. --- A log file, showing the messages in each packet processed and any
  47.     lines discarded, can be produced.
  48.  
  49.  
  50.  
  51. 2.      THE INTERNET HEADER PROBLEM
  52. ___________________________________
  53.  
  54.  
  55.  
  56. Typically the top of an internet/Usenet message contains the following
  57. (hereinafter referred to as "garbage"):
  58.   ┌─────────────────────────────────────────────────────────────────────────┐
  59.   │  @SUBJECT:Self Defeating Statements                                   N │
  60.   │  @FROM   :lrayner@scorpion.cowan.edu.au                               N │
  61.   │  @MSGID  :<lrayner.765116863@bluering.cowan.edu.au>                   N │
  62.   │ Path: proxima.alt.za!csir.co.za!ee.und.ac.za!hippo.ru.ac.za!psgrain!cha │
  63.   │ rnel!olivea!decwrl!hookup!europa.eng.gtefsd.com!howland.reston.ans.net! │
  64.   │ agate!ihnp4.ucsd.edu!munnari.oz.au!news.uwa.edu.au!bluering.cowan.edu.a │
  65.   │ u!scorpion!lrayner                                                      │
  66.   │ From: lrayner@scorpion.cowan.edu.au (Luke RAYNER)                       │
  67.   │ Newsgroups: alt.tasteless.jokes                                         │
  68.   │ Subject: Self Defeating Statements                                      │
  69.   │ Date: 31 Mar 94 12:27:43 GMT                                            │
  70.   │ Organization: Edith Cowan University                                    │
  71.   │ Lines: 5                                                                │
  72.   │ Message-ID: <lrayner.765116863@bluering.cowan.edu.au>                   │
  73.   └─────────────────────────────────────────────────────────────────────────┘
  74. Most of this information is of no interest to you. You may even have to
  75. scroll a little before you can read the actual message. On the other
  76. hand, there are lines in this sort of message which you may want to keep,
  77. e.g. the lines containing the Email address of the person who posted the
  78. message.
  79.  
  80. After running CLEANQWK in its default configuration on a QWK packet
  81. containing this garbage, the above was reduced to:-
  82.   ┌─────────────────────────────────────────────────────────────────────────┐
  83.   │ » From: lrayner@scorpion.cowan.edu.au (Luke RAYNER)                     │
  84.   │ » Subject: Self Defeating Statements                                    │
  85.   └─────────────────────────────────────────────────────────────────────────┘
  86.  
  87.  
  88.  
  89. 3.      HOW DO YOU RUN CLEANQWK?
  90. ________________________________
  91.  
  92.  
  93. It's easy.
  94.  
  95. Make sure that PKZIP and PKUNZIP are in a directory listed in the PATH
  96. statement of your AUTOEXEC.BAT file.  For the sake of convenience, you
  97. may also want to copy the CLEANQWK files into a directory in your PATH.
  98. (The only files necessary to run the program are CLEANQWK.EXE and
  99. CLEANQWK.CFG.)
  100.  
  101. Go into the directory in which your QWK packets are located.  Run the
  102. program against a QWK by typing
  103.  
  104.      CLEANQWK BBSID.QWK<Enter>
  105.  
  106. where BBSID is the name of the packet from the BBS from which you got
  107. the packet and the packet is the name of the file downloaded.
  108.  
  109. You can also run CLEANQWK as a batch file or as part of your download
  110. script.
  111.  
  112.  
  113. 4.      HOW DO YOU TELL THE PROGRAM WHICH LINES TO KEEP?
  114. ________________________________________________________
  115.  
  116.  
  117. Edit the CLEANQWK.CFG file in the same directory as CLEANQWK.EXE using
  118. your favourite ASCII editor.  Look for the section contining the "KEEP"
  119. command, and add/delete "KEEP =" lines until the list matches your
  120. preferences.  For example:
  121.  
  122.      KEEP = @From
  123.      KEEP = @Subject
  124.      KEEP = Newsgroup:
  125.  
  126. Note that the strings are case-insensitive.  @FROM is the same as @from.
  127.  
  128. If you run the program without a CLEANQWK.CFG file, the two default lines
  129. which the program will keep in your internet/Usenet messages are:-
  130.  
  131.      From:
  132.      Subject:
  133.  
  134.  
  135.  
  136. 5.      WHAT HAPPENS WHEN YOU RUN CLEANQWK?
  137. ___________________________________________
  138.  
  139.  
  140. When you run CLEANQWK without a CLEANQWK.CFG file, you get the following
  141. on your screen, progressing as the program operates:
  142.   ┌─────────────────────────────────────────────────────────────────────────┐
  143.   │                                                                         │
  144.   │ C:\TF>CLEANQWK BBSID.QWK                                                │
  145.   │ CLEANQWK V1.00 Copyright (C) 1994 Joe Malkin                            │
  146.   │                                                                         │
  147.   │ Configuration file (C:\UTILS\CLEANQWK.CFG) not found - using defaults   │
  148.   │ The following internet header lines will be kept:-                      │
  149.   │    "From:"                                                              │
  150.   │    "Subject:"                                                           │
  151.   │                                                                         │
  152.   │ Processing packet:     BBSID.QWK                                        │
  153.   │ Extracting:            MESSAGES.DAT and CONTROL.DAT                     │
  154.   │ Processing messages:   408 internet message(s) found.                   │
  155.   │ Making backup file:    BBSID.BAK                                        │
  156.   │ Stripping old packet:  BBSID.QWK                                        │
  157.   │ Replacing:             MESSAGES.DAT and *.NDX                           │
  158.   │ Cleaning up:           Deleting work files.                             │
  159.   │                                                                         │
  160.   │ Done!                                                                   │
  161.   │                                                                         │
  162.   └─────────────────────────────────────────────────────────────────────────┘
  163.  
  164. If you run the program with a modified CLEANQWK.CFG file, you will see
  165. something like the following on your screen:
  166.  
  167.   ┌─────────────────────────────────────────────────────────────────────────┐
  168.   │                                                                         │
  169.   │ C:\TF>CLEANQWK BBSID.QWK                                                │
  170.   │ CLEANQWK V1.00  Copyright (C) 1994 Joe Malkin                           │
  171.   │                                                                         │
  172.   │ The following internet header lines will be kept:-                      │
  173.   │    "from"                                                               │
  174.   │    "@from"